FOSS Documentation - Script commands

Index

@beep

@call

@Case

@+ [target] [1st#] [2nd#]

[index]

Description:

Add together two numbers and store result in given variable.

Parameters:

Parameter	Description
target	Identifier of variable to store result in
1st#	First of two numbers to add
2nd#	Second of two numbers to add

Example:

Codeline	Description	Output
@+ add_res 12 30	Add 12 and 30 and store the result in a variable named add_res
12+30=%add_res%		12+30=42

@- [target] [1st#] [2nd#]

[index]

Description:

Subtract one number from another and store result in given variable.

Parameters:

Parameter	Description
target	Identifier of variable to store result in
1st#	First of two numbers to add
2nd#	Second of two numbers to add

Example:

Codeline	Description	Output
@- sub_res 30 10	Subtract 10 from 30 and store the result in sub_res
30-10=%sub_res%		20

@/ [target] [1st#] [2nd#]

[index]

Description:

Divide one number on another and store result in given variable.

Parameters:

Parameter	Description
target	Identifier of variable to store result in
1st#	Number to divide
2nd#	Number to divide on

Example:

Codeline	Description	Output
@/ div_res 30 2	Divide 30 on 2 and store the result in a variable named div_res
30/2=%div_res%		30/2=15

@* [target] [1st#] [2nd#]

[index]

Description:

Multiply two numbers and store result in given variable.

Parameters:

Parameter	Description
target	Identifier of variable to store result in
1st#	1st number to multiply
2nd#	2nd number to multiply

Example:

Codeline	Description	Output
@* mlt_res 2 2	Multiply 2 and 2 and store the result in a variable named mlt_res
2*2=%mlt_res%		2*2=4

@beep [freq] [len]

[index]

Description:

Play a sound of given frequency and duration on the internal speaker of the local PC. No sound is sent remote.

Parameters:

Parameter	Description
freq	Frequency of sound in Hz
len	Length of sound in 1/1000th second

Example:

Codeline	Description	Output
@beep 5500 1000	Play a 5,5kHz sound for 1 second

@call [filename]

[index]

Description:

Call another script of given name, this script will continue when called script is done. Called script should reside in the SCRIPTS subdirectory.

Parameters:

Parameter	Description
filename	Name of script to call

Example:

Codeline	Description	Output
@call TEST	Call script SCRIPTS\TEST	(from script TEST only)

@Case [var]

[index]

Description:

Convert content of given variable to nice-case (First letter of all words to up-case, the rest is low-case).

Parameters:

Parameter	Description
var	Identifier of variable to convert

Example:

Codeline	Description	Output
@set one_var this is a test	Store value in variable one_var
@Case one_var	Convert content of one_var to nice-case
%one_var%		This Is A Test

@CASE [var]

[index]

Description:

Convert content of given variable to upper-case.

Parameters:

Parameter	Description
var	Identifier of variable to convert

Example:

Codeline	Description	Output
@set one_var This Is A Test	Store value in variable one_var
@CASE one_var	Convert content of one_var to upper-case
%one_var%		THIS IS A TEST

@command [command] {[command]...}

[index]

Description:

Run normal FOSS user prompt commands.

Parameters:

Parameter	Description
command	FOSS command to run

Example:

Codeline	Description	Output
@command ?	Display current menu	(current menu)

@debug {vardump}

[index]

Description:

With no parameters passed, this command turns on debug mode for the current script which means that each line will be written to the MAIN\USAGELOG.SYS file before processed.

Parameters:

Parameter	Description
vardump	Cause a screen dump of all allocated variables

Example:

Codeline	Description	Output
@debug	Init debug mode
@debug vardump	Display current variables	(dump of variables)

@delay [secs] {[char]}

[index]

Description:

Stop the script for a given number of seconds, with option to display a character each second.

Parameters:

Parameter	Description
secs	Number of seconds to delay
char	Optional character to print each second

Example:

Codeline	Description	Output
@delay 5 .	Delay for 5 seconds, send . each second	.....

@delfile [filename] {[filename] ...}

[index]

Description:

Delete one or more files.

Parameters:

Parameter	Description
filename	Name or path of file to delete

Example:

Codeline	Description	Output
@delfile test.tst	Delete file test.tst

@exit {[command] ...}

[index]

Description:

Exit script with option to add commands to systems command que. Commands given as a parameter to this command will be placed in the front of the command que.

Parameters:

Parameter	Description
command	Command to be added to command que

Example:

Codeline	Description	Output
@exit	End script
@exit ?	End script and show current menu	(current menu)

@file [filename]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@getfirst [target] [source]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@goto [label]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@if [str1] [str2] [label]
@if [1st#] <|<=|=|=>|> [2nd#] [label]

[index]

Description:

Compare two strings or two number with eachother.

Parameters:

Parameter	Description
str1 str2	Strings to be compared, these strings must be surrounded by " if they include spaces.
1st# 2nd#	Numbers to be compared
label	Label to jump to if argument given is true

Example:

Codeline	Description	Output
@if 1 = 1 Ok	Compare 1 and 1, jump to Ok if equal.
@if "Terje Flaaronning" "%usr_name%" Ok	Compare Terje Flaaronning aginst system variable usr_name and jump to Ok if equal.

@ifcommand [str] [command] [label]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@iffile [filename] [label]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@input

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@log {$}[text]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@math [target] [expr]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@mod [target] [1st#] [2nd#]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@readln [line#] [target] {[line#] [target] ...}

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@receive

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@return [retvalue] [commands]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@run [program] {params}

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@rundos [program] {params}

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@select "[keys]" [prompt]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@send [filename] {protocol}

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@set [ident] [value]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@show [filename]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@splitpath [path] [var4dir] [var4name]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@write [text]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output

@writeln [text]

[index]

Description:

Parameters:

Parameter	Description

Example:

Codeline	Description	Output